home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / archiver / crush1.zip / MANUAL.DOC < prev    next >
Text File  |  1994-06-18  |  42KB  |  954 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                        _________________________________
  13.  
  14.                                    CRUSH v1.0
  15.  
  16.                            **** Shareware Manual ****
  17.  
  18.                        __________________________________
  19.  
  20.  
  21.  
  22.                              File Compression Tool
  23.             CRUSH (TM) Copyright Jeff Rollason, PocketWare (TM) 1994
  24.                               All Rights Reserved
  25.  
  26.  
  27.  
  28.  
  29.                         All Trademarks Are Acknowledged
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.           No part of this publication may be reproduced, transmitted,
  39.           transcribed,  stored in  a retrieval system, or  translated
  40.           into any other language in whole or in part, in any form or
  41.           by  any  means,  whether  it  be  electronic,   mechanical,
  42.           magnetic,  optical,  manual  or  otherwise,  without  prior
  43.           written consent of PocketWare.
  44.  
  45.             PocketWare PO Box 2369, Hendon, London NW4 1NR, England.
  46.              CIS 100031,3537.  Internet 100031.3537@compuserve.com
  47.  
  48.  
  49.    __________________________________________________________________________
  50.    Contents:
  51.  
  52.  
  53.    CONTENTS:                                                             Page
  54.  
  55.    Getting Started: . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
  56.  
  57.    The CRUSH program: . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  58.  
  59.         Default use of PKZIP  . . . . . . . . . . . . . . . . . . . . . . . 3
  60.         -j    Use ARJ . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  61.         -o    Use ZOO . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  62.         -l    Use LHA . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  63.         -h    Use HA  . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
  64.         -m    Moves file to archive . . . . . . . . . . . . . . . . . . . . 3
  65.         -c    Compare with and without CRUSH  . . . . . . . . . . . . . . . 3
  66.         -f    Optimise until 5 failed attempts to improve compression . . . 4
  67.         -f<n> Optimise until "n" failed attempts to improve compression . . 4
  68.         -t    Only create CRUSH archive if 5% improvement . . . . . . . . . 4
  69.         -t<n> Only create CRUSH archive if "n"% improvement . . . . . . . . 4
  70.         -r    Recurse subdirectories  . . . . . . . . . . . . . . . . . . . 4
  71.         -:    Set range(s) of dates . . . . . . . . . . . . . . . . . . . . 5
  72.         -x    Exclude pathspecs . . . . . . . . . . . . . . . . . . . . . . 6
  73.         -y    Answer YES to all questions . . . . . . . . . . . . . . . . . 6
  74.         -z    Add CRUSH archive comment . . . . . . . . . . . . . . . . . . 6
  75.         -v    Show files for adding without CRUSHing  . . . . . . . . . . . 6
  76.         -n    Store files without paths . . . . . . . . . . . . . . . . . . 7
  77.         -Q    Query each file to be archived. . . . . . . . . . . . . . . . 7
  78.         -q    QUIET mode, no output . . . . . . . . . . . . . . . . . . . . 7
  79.         -a    Create an additional index  . . . . . . . . . . . . . . . . . 7
  80.         -e    Use the existing archive for comparison . . . . . . . . . . . 7
  81.         -C    Colour off  . . . . . . . . . . . . . . . . . . . . . . . . . 8
  82.         -C<n> Set colour  . . . . . . . . . . . . . . . . . . . . . . . . . 8
  83.         -s    Minimise temporary disk space (slow!) . . . . . . . . . . . . 8
  84.         -i<n> Control information type  . . . . . . . . . . . . . . . . . . 8
  85.         -2    Set display of times to 24 hour clock . . . . . . . . . . . . 8
  86.  
  87.  
  88.    The UNCRUSH Program: . . . . . . . . . . . . . . . . . . . . . . . . . . 9
  89.  
  90.         -v    Display without uncompressing . . . . . . . . . . . . . . . .10
  91.         -V    Display archive comment only  . . . . . . . . . . . . . . . .10
  92.         -o    Overwrite files without query . . . . . . . . . . . . . . . .10
  93.         -u    Uncompress NEWER or NEW files . . . . . . . . . . . . . . . .10
  94.         -a    Uncompress NEW files  . . . . . . . . . . . . . . . . . . . .10
  95.         -i    Ignore paths in CRUSH file  . . . . . . . . . . . . . . . . .10
  96.         -I    Only ignore drives in paths . . . . . . . . . . . . . . . . .10
  97.         -q    Quiet mode: No output at all  . . . . . . . . . . . . . . . .11
  98.         -z    Only suppress output of archiver  . . . . . . . . . . . . . .11
  99.         -e    Extract even if not CRUSH archive . . . . . . . . . . . . . .11
  100.         -l    Only display a simple file list . . . . . . . . . . . . . . .11
  101.         -2    Display times as 24-hour clock  . . . . . . . . . . . . . . .11
  102.  
  103.    Worked Examples: . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
  104.  
  105.    The UNDO and UNDO2 Programs: . . . . . . . . . . . . . . . . . . . . . .13
  106.  
  107.    Configuration: . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
  108.  
  109.    Technical Details: . . . . . . . . . . . . . . . . . . . . . . . . . . .15
  110.  
  111.  
  112.    _________________________________________________________________________
  113.    Getting Started                                                   Page  1
  114.  
  115.    ____________________________________
  116.    Installation
  117.  
  118.    CRUSH installation is very simple. The user need only copy the contents of
  119.    the  release disk to the desired directory. A file INSTALL.BAT is provided
  120.    to  do  this for you. Your  chosen directory should be within your  search
  121.    path (See the PATH variable in your DOS documentation).
  122.  
  123.    In  order  to be able to  use  CRUSH, you must have one of  the  archivers
  124.    PKZIP, ARJ, LHA, ZOO or HA.
  125.  
  126.    ____________________________________
  127.    What is CRUSH?
  128.  
  129.    CRUSH  is a command-line tool that uses your existing archiver PKZIP, ARJ,
  130.    LHA,  ZOO,  or HA to generate  smaller archives than it could alone.  With
  131.    many  applications  this improvement  may  be less than 5%,  but  dramatic
  132.    improvements  of  10%-70%  are  much  more typical. A block  test  of  128
  133.    archives  totalling 2349 wordprocessing files (see README) averaged a  47%
  134.    improvement  (100k ZIP reduced to 53k CRUSH!). CRUSH is ideally suited  to
  135.    users  who regularly archive material or who just need to save disk space.
  136.    There  is  no other compression tool  for DOS (as of June 1994)  that  can
  137.    match the compression performance of CRUSH, and most do not come close.
  138.  
  139.    ____________________________________
  140.    CRUSH and other Archivers
  141.  
  142.    CRUSH is used from the command-line in much the same way as archivers such
  143.    as  PKZIP and ARJ. If you are already familiar with these, then you should
  144.    be  able to adapt to CRUSH with very little difficulty. If you are a  ZOO,
  145.    LHA  or  HA user, then you  will observe some changes, but will  find  the
  146.    basic operation of CRUSH very similar.
  147.  
  148.    ____________________________________
  149.    Simple use of CRUSH
  150.  
  151.    To  create a CRUSH archive called  BACKUP containing all the files in  the
  152.    current directory requires the following simple command:
  153.  
  154.         CRUSH BACKUP
  155.  
  156.    This  will create the file BACKUP.ZIP (PKZIP must be available). The  user
  157.    can be more selective by adding filespecs, as follows:
  158.  
  159.         CRUSH BACKUP *.DOC README MAN*.*
  160.  
  161.    This  will only save files with the specified filespecs. The user may also
  162.    want  to  receive some feedback about  how much space is being saved.  The
  163.    "-c" (compare) option will allow a comparison to be made:
  164.  
  165.         CRUSH -c BACKUP *.DOC README MAN*.*
  166.  
  167.    Once  created, a CRUSH archive  can be uncompressed using UNCRUSH in  much
  168.    the  same  way as PKUNZIP  is used. e.g.  UNCRUSH BACKUP *.DOC. This  only
  169.    extracts  files  matching *.DOC. The  user is advised to read the  "Worked
  170.    Examples"  section  for more details  of CRUSH usage, and also the  README
  171.    file.  Simply type "CRUSH" to obtain on-line help.
  172.  
  173.  
  174.    _________________________________________________________________________
  175.    The CRUSH program                                                 Page  2
  176.  
  177.  
  178.    This  is the program that will replace the use of PKZIP, LHA, ARJ, ZOO and
  179.    HA.  Whichever  of these you already  use will still be needed, but  CRUSH
  180.    will  run it for you. The command-line syntax of CRUSH is, for most cases,
  181.    identical